home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / mac / progrmng / intcdvpc.sit / INIT_cdev IPC README / INIT_cdev IPC README
Encoding:
Text File  |  1990-09-17  |  6.7 KB  |  125 lines  |  [TEXT/MPS ]
  1. # INIT developer helper and IPC example. Version 2.0
  2. #  ⌐ Copyright 1990 Jeremy Grodberg.  All Rights Reserved
  3. #
  4. #    Development system: MPW 3.1 
  5. #
  6. # Unmodified copies of this source and object code may be distributed free of charge.
  7. # Adaptations of this code for other development systems may be made and distributed
  8. # as part of said development system, otherwise, neither this code not adaptations of
  9. # it may be distributed along with other products for which a fee is charged.
  10. #
  11. # Apple Computer, Inc. is specifically granted non-exclusive permission to distribute 
  12. # this code by any means, either for free, or with other code for which a fee is 
  13. # charged, provided they do not impose further restrictions on its use, and they
  14. # include this entire copyright notice.
  15. # 
  16. # This source is provided to make writing INITs and cdevs a little easier.  
  17. # RegisterMySignature can also be helpful to anyone who wants to install a DRVR.
  18. # If you find it helpful, please send me a copy of your finished product.
  19. #
  20. # THIS SOURCE IS PROVIDE AS IS, AND ALL WARRANTIES ARE EXPLICITY DISCLAIMED.
  21. # BY USING THIS WORK, THE USER AGREES TO ASSUME ALL RESPONSIBILITY FOR 
  22. # DAMAGES THAT MAY ARISE AS A RESULT, AND TO PROTECT FROM HARM ALL ENTITIES
  23. # INVOLVED IN THE CREATION AND DISTRIBUTION OF THIS WORK.
  24. #
  25. # Jeremy Grodberg.  September, 1990
  26. # jgro@lia.com  (via AppleLink: jgro@lia.com@INTERNET#)
  27. # America Online: jgro (I don't read this very often)
  28.  
  29. * Changes since Version 1.0:  Support for systems that do not support Gestalt
  30.  
  31.  
  32. * This is a library of code which you can use to share memory across processes.
  33. * While you could use this for any kind of inter-process communication, it is
  34. * especially intended to allow a control panel (cdev) to alter the behavior
  35. * of a startup document (INIT) while the latter is running (that is, without
  36. * restarting the computer).  Entry points are defined as a Pascal functions so 
  37. * you can call it from an Application if you want to.
  38. *
  39. * The theory behind this is that your INIT will have a block of variables which 
  40. * it needs to use for various purposes, including storing user options.
  41. * The user options would be stored in a resource which is a copy of the
  42. * INIT's variables, and could be edited by a Control Panel Device (cdev).
  43. * At INIT time, the (edited) resource is copied into the INIT's variables for 
  44. * the INIT to use.  In other words, to change the user options, the user uses
  45. * the cdev to edit the resource, which will change the options the next time the
  46. * INIT is loaded.
  47. * 
  48. * This is how most INITs are written, and this is why most INITs require a 
  49. * reboot for changes to take effect.  Before now, there was no simple way
  50. * for a cdev to get a hold of the INITs variables, so it could only communicate by
  51. * changing the resource and then reinitializing the INIT.
  52. *
  53. * Now with RegisterMySignature, your INIT can register itself and provide a pointer to 
  54. * anyone that wants it.  RegisterMySignature takes a selector which is an OSType, and
  55. * returns a longint.  For your INIT, you register your INIT's creator bytes 
  56. * (which you have cleared with Apple by registering with MacDTS) and whatever
  57. * longint you want, presumably the pointer to your INIT's variables. Later,
  58. * your cdev will call LookupMySignature with your INITs creator bytes, and get back
  59. * the pointer to the variables, so they can be changed in real time.  It will
  60. * also be able to tell if the INIT was not installed, because the creator bytes
  61. * will not be registered.  See the accompanying SampleLookup.c for an example.
  62. *
  63. * On systems that support Gestalt (System 6.0.4 and later), Gestalt is used to 
  64. * do the actual registration and lookup.  On older systems, a driver (DRVR) is 
  65. * installed which will do the registration.  The driver's source code is not
  66. * included, but the DRVR resource is. You don't need to do anything with the driver
  67. * but include it in your INIT.  RegisterMySignature and LookupMySignature take
  68. * care of everything automatically.
  69. *
  70. * For an excellent start on how to write INITs, 
  71. * read Technote #256, August 1990 revsion.
  72.  
  73.  
  74. # This package contains 6 files besides this one.  
  75. #        SampleINIT.a is an INIT which you can use as a template for your own INITs
  76. #        RegisterMySignature.c registers a signature and longint for later lookup by the 
  77. #            same or another process.  It uses Gestalt if available, or installs the Driver 
  78. #         contained in IPCDriver.rsrc and uses that.  The Driver must be in a resource
  79. #            file that is open when RegisterMySignature is called (such as the the INIT
  80. #            file which calls RegisterMySignature).  RegisterMySignature
  81. #            also can be used to pass the address of shared memory between multiple
  82. #            processes, making Inter-Process Communication available right now.
  83. #        RegisterWithGestalt.a is a utility function which uses Gestalt to register the
  84. #            address of the INIT's globals, for use by the INIT's cdev.  
  85. #        LookupMySignature.c contains LookupMySignature(), which is the library entry 
  86. #            for looking up the data registered by RegisterMySignature. LookupMySignature.c
  87. #            also contains AskGestalt.c, which is the utility corresponding to 
  88. #            RegisterWithGestalt, and which is called automatically by LookupMySignature().
  89. #        SampleLookup.c shows a very simple example of how you would use LookupMySignature
  90. #            to get the address of the INIT's (or IPC's) memory.
  91. #        IPCDriver.rsrc contains the DRVR resource which does the register and lookup
  92. #            on systems that don't support Gestalt.  The driver must be copied into any 
  93. #            executable file (Application, INIT, etc.) which calls RegisterMySignature.
  94. #     The driver must be named "..ipc by jgro" and should have its SystemHeap
  95. #            flag set.
  96.  
  97. # To compile and link SampleINIT as provided, you need to have a copy of ShowINIT
  98. # already compiled.  ShowINIT is on the Developer CD, and available elsewhere.
  99. # If you don't have a copy of ShowINIT, you can make the changes noted in 
  100. # SampleINIT.a and remove ShowINIT.a.o from the link line.
  101.  
  102.  
  103.  
  104.  
  105. # Execute the lines below to compile and link the SampleINIT.  Note that SampleINIT
  106. # doesn't do anything useful, so there's not much point in installing it.
  107. # Uncomment the -l to get a listing in <sourcefile>.lst
  108.  
  109. C -b2 LookupMySignature.c
  110. C -b2 RegisterMySignature.c 
  111. Asm RegisterWithGestalt.a -o RegisterWithGestalt.a.o    # -l -font monaco,9 
  112. Asm SampleINIT.a -o SampleINIT.a.o   # -l -font monaco,9 
  113.      
  114. Link SampleINIT.a.o ShowINIT.a.o RegisterMySignature.c.o ╢
  115.         RegisterWithGestalt.a.o "{Libraries}Interface.o" ╢
  116.         -o SampleINIT ╢
  117.         -m SAMPLE -sg SampleINIT -rt INIT=1  -t 'INIT' -c '????'
  118.  
  119.  
  120. # your cdev's link line would look something like this:
  121. #Link YourCdev.c.o SampleINIT.a.o LookupMySignature.c.o  ╢
  122. #        "{Libraries}Interface.o" ╢
  123. #        -o SampleINIT ╢
  124. #        -m YourCdevEntrypoint -sg YourCdevName -rt cdev=1  -t 'cdev' -c '????'
  125.